<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:14 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>AttributeColumnsManipulator (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="AttributeColumnsManipulator (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AttributeColumnsManipulator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulatorUI.html" title="interface in org.gephi.datalab.spi.columns"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html" target="_top">Frames</a></li>
<li><a href="AttributeColumnsManipulator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.datalab.spi.columns</div>
<h2 title="Interface AttributeColumnsManipulator" class="title">Interface AttributeColumnsManipulator</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="strong">AttributeColumnsManipulator</span></pre>
<div class="block"><p>Manipulation action to use for Data Laboratory column manipulator buttons.</p>
 <p>This special type of manipulator does not need any builder, implementations can be published simply with <code>@ServiceProvider(service = AttributeColumnsManipulator.class)</code> annotation</p>
 <p>These are shown as drop down buttons and are able to:</p>
 <ul>
  <li>Execute an action with 1 column</li>
  <li>Provide a name, description, type and order of appearance (position in group of its type)</li>
  <li>Indicate wether they can be executed on a specific AttributeColumn or not</li>
  <li>Provide and UI or not</li>
  <li>Provide and icon or not</li>
 </ul></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Eduardo Ramos <eduramiba@gmail.com></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#canManipulateColumn(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">canManipulateColumn</a></strong>(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
                   <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</code>
<div class="block">Indicates if this AttributeColumnsManipulator can manipulate a specific AttributeColumn.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#execute(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">execute</a></strong>(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
       <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</code>
<div class="block">Execute this AttributeColumnsManipulator with the indicated table and column</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getDescription()">getDescription</a></strong>()</code>
<div class="block">Description of the AttributeColumnsManipulator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Image.html?is-external=true" title="class or interface in java.awt">Image</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getIcon()">getIcon</a></strong>()</code>
<div class="block">Returns an icon for this AttributeColumnsManipulator if necessary.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getName()">getName</a></strong>()</code>
<div class="block">Return name to show for this AttributeColumnsManipulator on the ui.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getPosition()">getPosition</a></strong>()</code>
<div class="block">Returns a position value that indicates the position
 of this AttributeColumnsManipulator in its type group.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getType()">getType</a></strong>()</code>
<div class="block">Type of manipulator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulatorUI.html" title="interface in org.gephi.datalab.spi.columns">AttributeColumnsManipulatorUI</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html#getUI(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">getUI</a></strong>(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
     <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</code>
<div class="block">Returns a ManipulatorUI for this Manipulator if it needs one.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="execute(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>execute</h4>
<pre>void&nbsp;execute(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
           <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</pre>
<div class="block">Execute this AttributeColumnsManipulator with the indicated table and column</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - AttributeTable of the column</dd><dd><code>column</code> - AttributeColumn of the table to manipulate</dd></dl>
</li>
</ul>
<a name="getName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
<div class="block">Return name to show for this AttributeColumnsManipulator on the ui.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Name to show in UI</dd></dl>
</li>
</ul>
<a name="getDescription()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDescription()</pre>
<div class="block">Description of the AttributeColumnsManipulator.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Description</dd></dl>
</li>
</ul>
<a name="canManipulateColumn(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>canManipulateColumn</h4>
<pre>boolean&nbsp;canManipulateColumn(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
                          <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</pre>
<div class="block">Indicates if this AttributeColumnsManipulator can manipulate a specific AttributeColumn.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>True if it can manipulate the column, false otherwise</dd></dl>
</li>
</ul>
<a name="getUI(org.gephi.data.attributes.api.AttributeTable, org.gephi.data.attributes.api.AttributeColumn)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUI</h4>
<pre><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulatorUI.html" title="interface in org.gephi.datalab.spi.columns">AttributeColumnsManipulatorUI</a>&nbsp;getUI(<a href="../../../../../org/gephi/data/attributes/api/AttributeTable.html" title="interface in org.gephi.data.attributes.api">AttributeTable</a>&nbsp;table,
                                  <a href="../../../../../org/gephi/data/attributes/api/AttributeColumn.html" title="interface in org.gephi.data.attributes.api">AttributeColumn</a>&nbsp;column)</pre>
<div class="block">Returns a ManipulatorUI for this Manipulator if it needs one.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>table</code> - AttributeTable of the column</dd><dd><code>column</code> - AttributeColumn of the table to manipulate</dd>
<dt><span class="strong">Returns:</span></dt><dd>ManipulatorUI for this Manipulator or null</dd></dl>
</li>
</ul>
<a name="getType()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>int&nbsp;getType()</pre>
<div class="block">Type of manipulator. This is used for separating the manipulators
 in groups when shown. First types to show will be the lesser.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Type of this manipulator</dd></dl>
</li>
</ul>
<a name="getPosition()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPosition</h4>
<pre>int&nbsp;getPosition()</pre>
<div class="block">Returns a position value that indicates the position
 of this AttributeColumnsManipulator in its type group. Less means upper.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>This AttributeColumnsManipulator position</dd></dl>
</li>
</ul>
<a name="getIcon()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getIcon</h4>
<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/awt/Image.html?is-external=true" title="class or interface in java.awt">Image</a>&nbsp;getIcon()</pre>
<div class="block">Returns an icon for this AttributeColumnsManipulator if necessary.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Icon for the manipulator or null</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/AttributeColumnsManipulator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../org/gephi/datalab/spi/columns/AttributeColumnsManipulatorUI.html" title="interface in org.gephi.datalab.spi.columns"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/gephi/datalab/spi/columns/AttributeColumnsManipulator.html" target="_top">Frames</a></li>
<li><a href="AttributeColumnsManipulator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
